home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / remote / ma_103.zip / MA.DOC next >
Text File  |  1991-12-10  |  13KB  |  336 lines

  1.    
  2.  
  3. Message Alert v1.02    03 Nov 91   
  4.  
  5. Plain Jayne Software, home of TPBoard v7
  6.  
  7. Distributed by:
  8.  
  9.    Online Communications Inc
  10.    22 State Street  
  11.    Bangor, Maine, U.S.A. 04401
  12.    Voice (207) 941-1110   
  13.    Fidonet 1:132/300 
  14.  
  15.  
  16. What is Message Alert?
  17. ----------------------
  18. Message Alert (MA) is a message base utility program that tells
  19. you when any messages containing key phrases are received on your
  20. system.  MA alerts you to these messages by creating its own 
  21. message in your netmail message area.  The easiest way to explain
  22. MA is to present an example.
  23.  
  24. Let's say you are running FrontDoor in a private network that 
  25. exchanges 14 echo areas in addition to Netmail.  You don't need 
  26. to read all of the messages every day yet you do have to at least
  27. scan every folder (message area) daily looking for certain key
  28. messages of interest.  This is where MA comes in.  
  29.  
  30. You can set up MA to watch specific folders (or ALL folders) for
  31. any incoming messages that contain key phrases.  You further tell
  32. MA where in the messages to search for each search phrase.  You
  33. could set up one search phrase in NetMail to search for any 
  34. message where the sender's name contains the phrase "McDaniel."
  35. You could set up a search with a phrase of "modems" and have MA 
  36. search only the subject lines of messages in the folder FD_DEV.
  37.    
  38. Simply put, MA alerts you to any incoming messages from a person, 
  39. to a person, about a subject, or containing a phrase in the body 
  40. of the text.  
  41.  
  42. MA and FrontDoor
  43. ----------------
  44. In order for MA to work, you must be using FrontDoor and MUST
  45. have all of your message folders set up as Folders in FDSETUP.
  46. If you are running FrontDoor and a bulletin board system using
  47. the Hudson style message format, you must still have every 
  48. message area set up as a folder in FOLDER.FD.
  49.  
  50. MA requires that you are running FrontDoor and that your
  51. FD config file be in the 2.02 format.  In other words, your FD 
  52. configuration file must be named SETUP.FD.  Older versions of
  53. FD called the cfg file FD.SYS and it is safe to copy FD.SYS 
  54. as SETUP.FD in the FD directory.  MA will NOT run properly if
  55. you are not using FrontDoor or if the SETUP.FD file is not 
  56. found.
  57.  
  58. You do not have to run MA from the FD directory; however, you
  59. must run MA from the directory where the MA.EXE file is located.
  60.  
  61. MA and Message Bases Formats
  62. ----------------------------
  63. MA currently works on two types of message bases:
  64.  
  65.    1) The Opus/FD style using .MSG files.
  66.    2) The Hudson format used by QuickBBS and support by certain
  67.       versions of TosScan/FD. 
  68.    -) There are plans to support the TPBoard message base
  69.       as well.
  70.  
  71. The Opus format requires no additional setup when using MA.
  72.  
  73. The Hudson message format does require special instruction.
  74. If you are using the Hudson format with TosScan (no bulletin
  75. board), you must establish a User named "MA MA" in FDSetup
  76. (without the quotes).  Users are edited under the menu 
  77. option GLOBAL.  
  78.    
  79. If you are using the Hudson format with a bulletin board, you 
  80. must add a user to your USERS.BBS file.   The earlier in your
  81. USERS file that you add "MA MA," the faster will be MA's search
  82. for that record.   This provides MA with access to the LastRead 
  83. record used by MA to record scanned messages. 
  84.  
  85. Setting up MA
  86. -------------
  87. MA requires very little configuration.  Run MA from the DOS
  88. prompt and you will see a pull-down menu with the following
  89. main-bar options:
  90.  
  91.    Configs   Scan   Locks   Exit
  92.  
  93. Move the highlight bar to Configs and press [Enter].  You now
  94. have two choices:  Searches and Options; select Options.
  95.  
  96. The settings you see are the only settings required for MA
  97. other than the message Search criteria records.  For full
  98. help on what these settings do, move the highlight bar to
  99. any setting and press [F1].   But briefly:
  100.  
  101.    Editor:  When you run a scan of messages from the pull-down 
  102.             menu, a file is created with a report of the results.
  103.             To view this file, MA calls the editor you specify
  104.             here.
  105.    Color:   A Yes or No setting to turn color on/off in MA.
  106.    Lock:    When messages are found that match a search record,
  107.             you have the option of "locking" to prevent them from
  108.             being deleted.  Make very sure that you aren't running
  109.             any other utilities that will have problems with locked
  110.             .MSG files.
  111.    Style:   Which style of message base are you using.  If you 
  112.             select Hudson and don't have the necerray support files
  113.             available, you won't be able to reenter MA without
  114.             deleting the MA.CFG file.
  115.    Users:   If you are running a Hudson format message base with 
  116.             a bulletin board, this sets the DOS path to your 
  117.             Users.bbs file.
  118.   
  119. To save these settings after editing, select the SAVE option from
  120. the Exit menu.
  121.  
  122. Search records
  123. --------------
  124. These records specify the criteria for MA's scans through the
  125. message base.  A search record consists of:
  126.    
  127.    -   a phrase to search for
  128.    -   instructions on which part of the message to search
  129.    -   the folder in which to search
  130.    -   instructions on deleting matching records 
  131.    -   any special instructions according to the type of search
  132.  
  133. To edit/create search records, select SEARCH from the Configs
  134. menu.   The screen you will see appears something like:
  135.  
  136.    Folder:  _____________
  137.    Phrase:  _____________
  138.    Search:  _____________
  139.    Flags:   _____________
  140.    Delete:  _____________
  141.  
  142. Initially, the Folder selected will be the first folder in your
  143. FOLDER file.  If you have created any search records for this
  144. folder, you will see the data for the first search record for 
  145. that folder.  If the phrase is blank (empty), there are NO
  146. search records for this folder and you are looking at a new
  147. search record which will only be saved when or if completed.
  148.  
  149. Try pressing [ENTER] while the highlight bar is on FOLDER;
  150. you will see a list of all the available folders.  By selecting
  151. any of them, you will change to the list of search records for
  152. the selected folder.   Once you select a folder, all operations
  153. such as adding and deleting are for THAT folder until you select
  154. a different folder.
  155.  
  156. We'll skip Phrase for a moment...
  157.  
  158. SEARCH tells MA which part of the message you wish to scan.
  159. The options are:  
  160.  
  161.    1)  The text of the message
  162.    2)  The subject line of the message
  163.    3)  The names of the message (both FROM and TO)
  164.  
  165. If you want to watch for the same phrase in both the subject and
  166. text of the message, you will need to create two search records 
  167. for that folder with each having the same search phrase.
  168.  
  169. PHRASE is the phrase you wish to have MA watch for.  There
  170. are several considerations depending on which SEARCH type
  171. you select.  If you are searching in either the text of the
  172. message or the subject line, the message will be considered
  173. a "match" and you will be alerted to that message *IF* the 
  174. phrase you enter is present ANYWHERE within the subject (or 
  175. text) or the message.  The search is case insensitive.
  176.  
  177. When searching in the subject line or message text, you can
  178. further specify TWO search phrases which MUST appear together
  179. in the same message subject line (or together in the message
  180. text) to be considered a matching message.  To enter two
  181. search phrases in the same search record, separate them with
  182. two forward slash letters.   Example:   quayle//bozo  as a 
  183. text search would look for QUAYLE and BOZO together in a 
  184. message.  
  185.  
  186. If you are searching the NAME fields of a message, you have
  187. three additional commands to use.  
  188.  
  189.    1)  If you enter a phrase that begins with an exclamation
  190.        point, MA will search for any names that BEGIN with the
  191.        following text.   For example:   !MI would consider
  192.        matching any names beginning with MI.
  193.  
  194.    2)  If you enter a phrase that begins with an @ mark,
  195.        MA will search for any names that contains the
  196.        following text.   For example:   @MI would consider
  197.        matching any names that contain MI.
  198.  
  199.    3)  If you don't use any of the above two command, MA will
  200.        expect an exact match.  If you enter "John Henry", MA
  201.        will only consider a match the full name "John Henry".
  202.  
  203. FLAGS.  Currently, only the name SEARCH types support any
  204. additional flags.  When searching the name fields, you must tell
  205. MA which name field to search:  the FROM name, the TO name, or
  206. BOTH names.   
  207.  
  208. DELETE.  When searching the name fields, you have the 
  209. additional option of deleting any matching messages.  This option
  210. only works in the OPUS style message base.  You would use this
  211. option when you absolutely didn't  want any messages entering
  212. your system from a particular source (person).
  213.  
  214. Adding records
  215. --------------
  216. Search records are added by pressing [INS].  You will see a
  217. new record appear with a blank phrase field.   You can add as
  218. many records as you wish; however, only complete records are 
  219. saved on exiting MA.
  220.  
  221. Deleting records
  222. ----------------
  223. Search records are deleted by pressing [DEL].  If the record
  224. phrase is blank and there are no records remaining for the 
  225. current folder, there is no harming is pressing the [DEL] 
  226. key.
  227.  
  228. SCANNING
  229. --------
  230. The process of having MA search through new messages is called
  231. a "scan."  If you have added new search records and want MA to
  232. look through messages it has already looked through, that is
  233. called a "rescan."  Both of these are options from the SCAN
  234. selection on the main menu bar.  You can scan or rescan from
  235. the menu but MA was really intended to run from a batch file
  236. following new incoming mail.  In this way, MA performs the
  237. searching whenever mail arrives without your instruction every
  238. time.
  239.  
  240. To run a scan without entering MA, type MA at the DOS prompt
  241. followed by any mix of the following options:
  242.  
  243.    /?  = displays this help list
  244.    /S  = instructions to perform a scan
  245.    /M  = instructions to output a netmail message report 
  246.    /F  = forces a rescan of previoulsy scanned messages
  247.    /L  = turns off locking regardless of MA's settings
  248.    /Q  = runs MA in quick mode      
  249.  
  250. /S Scan
  251. This option is required to initiate  a scan from the DOS prompt.
  252. Without this option, MA will load in full screen mode regardless
  253. of any other option (other than /?).
  254.  
  255. /M  MESSAGE
  256. This tells MA to produce a .MSG file in your netmail area with
  257. a report on the findings of this scan.  If you don't use /M, you
  258. will have to check for the report file MASCAN.OUT.
  259.  
  260. /F  FORCE RESCAN
  261. Use with -- not to replace -- the /S option, this tells MA to
  262. extend the scan to already scanned messages.  MA knows which 
  263. messages have been scanned by either the lastread counters (in
  264. the Hudson format) or a flag set in the message itself (OPUS
  265. style base).
  266.  
  267. /L  LOCK Override
  268. Overrides the internal "lock" settings and disables message
  269. locking.
  270.  
  271. /Q  Quickmode
  272. Normally, MA scans by folder and takes the search records in
  273. sequence.   This means that for EACH search record, ALL
  274. messages must be read in.  This is done to produce a report
  275. like the following:
  276.  
  277.    SYS18
  278.    -----
  279.    COSTS   Text search
  280.       Msg# 1   JAMES SMITH                  ANTHONY LISA ET AL
  281.       Msg# 10  JAMES SMITH                  JOHN NELSON
  282.  
  283.    TEST   Text search
  284.       Msg# 2  JAMES SMITH                   NO ONE
  285.  
  286.    QUALYE//MORON   Text search
  287.       Msg# 1  MANIAC                        SECRET SERVICE
  288.  
  289. Note that all findings (see the COSTS text search) for a particular
  290. search are grouped together.  To do this, the same messages had to
  291. be read for scan for each of the subsequent searches.
  292.  
  293. QUICK mode changes that to open each message once and then for
  294. that message, run through all the searches:
  295.  
  296.    SYS18
  297.    -----
  298.    MSG# 1
  299.      COSTS   Text search
  300.         JAMES SMITH                  ANTHONY LISA ET AL
  301.         MANIAC                       SECRET SERVICE
  302.  
  303.    MSG# 10 
  304.       COSTS   Text search
  305.         JAMES SMITH                  JOHN NELSON
  306.  
  307.    MSG# 2  
  308.       TEST   Text search
  309.          QUALYE//MORON   Text search
  310.  
  311. This saves a marginal amount of time because MA only opens each 
  312. message once.  The savings are about 20-25% but the primary
  313. factor is the difference in the format of the reports.  Do you
  314. want all matches for a message to be grouped together?  Or would
  315. your prefer all findings for a search to list the matched 
  316. messages?
  317.  
  318. Locking/Unlocking
  319. -----------------
  320. Message locking and unlocking is only performed on the OPUS
  321. .MSG style message base.  If you are running a bulletin
  322. board that imports from the OPUS format, you should ensure
  323. that you importer can import READ-ONLY message files before
  324. enabling locking.
  325.  
  326. How do I register MA?
  327. ---------------------
  328. MA is only available in registered versions.   For registration 
  329. information, contact:
  330.  
  331.    Online Communications Inc
  332.    22 State Street  
  333.    Bangor, Maine, U.S.A. 04401
  334.    Voice (207) 941-1110   
  335.    Fidonet 1:132/300 
  336.